OxideTalis/oxidetalis
OxideTalis/oxidetalis
1
Fork 1
Code Issues 10 Pull requests Projects 1 Releases Activity Actions

Powerfull openapi description #20

New issue
Open
opened 2024-07-16 15:38:18 +02:00 by awiteb · 0 comments
awiteb commented 2024-07-16 15:38:18 +02:00
Owner
Copy link

Current openapi description extracted from the config only, so it's will not
contain all the information about the API. I think about putting the user
description in top of our openapi description, so it's will be more powerfull
and more informative.

Should include

  • How registration works
  • How rate limiting works
  • How the signature works
  • Clarify that 🔐 emoji means the endpoint for registered users only
  • Refrence to the OTMP site and the git repo
Current openapi description extracted from the config only, so it's will not contain all the information about the API. I think about putting the user description in top of our openapi description, so it's will be more powerfull and more informative. ### Should include - How registration works - How rate limiting works - How the signature works - Clarify that `🔐` emoji means the endpoint for registered users only - Refrence to the OTMP site and the git repo
awiteb added the
Reviewed
Accepted
 label 2024-07-16 15:38:18 +02:00
awiteb self-assigned this 2024-07-16 15:38:18 +02:00
awiteb added the
Kind/Enhancement
 label 2024-07-16 15:41:44 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
No results found.
Labels
Clear labels
  
Good First Issue

Good for newcomers

  
Help wanted

Request for help from the contributors

  
Kind/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Bug Fix

Pull request that fix a bug

  
Kind/CI-CD

Something related to the CI/CD

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Question

Question related to the project

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Reviewed
Accepted
Feature Request or Proposal was accepted by maintainers and will be implemented

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Declined
Feature Request or Proposal was declined by maintainers

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Approved
The PR is approved by reviewers and is ready to be merged

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Inactive
Inactive and waiting on the author. This is often applied to closed PRs

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

  
Status
Waiting On Author
This is awaiting some action (such as code changes or more information) from the author

  
Status
Waiting On Review
Awaiting review from the assignee

No labels
Good First Issue
Help wanted
Kind/Breaking
Kind/Bug
Kind/Bug Fix
Kind/CI-CD
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Question
Kind/Security
Kind/Testing
Reviewed
Accepted
Reviewed
Confirmed
Reviewed
Declined
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Approved
Status
Blocked
Status
Inactive
Status
Need More Info
Status
Waiting On Author
Status
Waiting On Review
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
awiteb
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: OxideTalis/oxidetalis#20
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?