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 person show endpoint #10633

Merged
merged 1 commit into from
Jan 20, 2021

Conversation

danidoni
Copy link
Contributor

The OpenAPI documentation for the person#show action.

Replace this line with a description of your changes. Please follow the suggestions in the comment below.


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

@danidoni danidoni added the Documentation 📖 Things regarding our documentation label Jan 15, 2021
Copy link
Contributor

@dmarcoux dmarcoux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a typo in the commit message: endpoint instead of endpoing

src/api/public/apidocs-new/paths/person.yaml Outdated Show resolved Hide resolved
@danidoni danidoni changed the title Document person show endpoing Document person show endpoint Jan 18, 2021
@danidoni danidoni force-pushed the document-person-show-action branch 3 times, most recently from 0c55b7f to dab42a4 Compare January 18, 2021 17:04
@danidoni danidoni marked this pull request as ready for review January 18, 2021 17:10
@danidoni
Copy link
Contributor Author

Person

Copy link
Member

@eduardoj eduardoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I would merge the commits into the first one.

@danidoni danidoni force-pushed the document-person-show-action branch 2 times, most recently from 6983e7b to 79ed0dc Compare January 19, 2021 14:38
The OpenAPI documentation for the `person#show` action.
@danidoni danidoni merged commit 3f372cf into openSUSE:master Jan 20, 2021
@danidoni danidoni deleted the document-person-show-action branch January 20, 2021 10:03
@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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants