Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document '/attribute' API routes with OpenAPI #10605

Merged

Conversation

eduardoj
Copy link
Member

@eduardoj eduardoj commented Jan 8, 2021

Introduce the new "Attributes" group of operations. This group contains the documentation of all operations with API routes starting by '/attribute'.

To verify the documetation that has been introduced:

Screenshot from 2021-01-08 19-00-55


If this PR requires any particular action or consideration before deployment,
please check the reasons or add your own to the list:

  • Requires a database migration that can cause downtime. Postpone deployment until maintenance window[1].
  • Contains a data migration that can cause temporary inconsistency, so should be run at a specific point of time.
  • Changes some configuration files (e.g. options.yml), so the changes have to be applied manually in the reference server.
  • A new Feature Toggle[2] should be enabled in the reference server.
  • Proper documentation or announcement has to be published upfront since the introduced changes can confuse the users.

[1] https://github.com/openSUSE/open-build-service/wiki/Deployment-of-build.opensuse.org#when-there-are-migrations
[2] https://github.com/openSUSE/open-build-service/wiki/Feature-Toggles-%28Flipper%29#you-want-real-people-to-test-your-feature

@eduardoj eduardoj added Documentation 📖 Things regarding our documentation review-app Apply this label if you want a review app started labels Jan 8, 2021
@obs-bot
Copy link
Collaborator

obs-bot commented Jan 8, 2021

@eduardoj eduardoj force-pushed the document_attribute_routes_with_openapi branch 3 times, most recently from 496f328 to 5535401 Compare January 11, 2021 19:31
@hennevogel
Copy link
Member

In general, can we order the documentation by?

  • List
  • Show
  • Create/Update
  • Delete

@eduardoj eduardoj force-pushed the document_attribute_routes_with_openapi branch from 5535401 to 06b0626 Compare January 20, 2021 11:04
Document all these routes under the new "Attribute Namespaces" and
"Attributes" groups.
@eduardoj eduardoj force-pushed the document_attribute_routes_with_openapi branch from 06b0626 to 2b6c6af Compare January 20, 2021 11:16
@eduardoj eduardoj merged commit cc9879e into openSUSE:master Jan 20, 2021
@eduardoj eduardoj deleted the document_attribute_routes_with_openapi branch January 20, 2021 12:35
@dmarcoux dmarcoux added the API Things regarding our API label Jan 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Things regarding our API Documentation 📖 Things regarding our documentation review-app Apply this label if you want a review app started
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants