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

Revert "Removed obsolete parameters from OpenAPI specs" #1700

Merged
merged 2 commits into from May 28, 2023

Conversation

christianlupus
Copy link
Collaborator

Topic and Scope

This reverts commit 07954bf.

The @type annotation should be still part of the OpenAPI description. Although the returned JSON objects are considered compatible with the schema.org standard, this does not mean, we should not make the implications explicit. Also, this makes reading more clean and avoid misunderstandings regarding if the @type is to be present or not.

Concerns/issues

Just documentation, no effects

Formal requirements

There are some formal requirements that should be satisfied. Please mark those by checking the corresponding box.

  • I did check that the app can still be opened and does not throw any browser logs
  • I created tests for newly added PHP code (check this if no PHP changes were made)
  • I updated the OpenAPI specs and added an entry to the API changelog (check if API was not modified)
  • I notified the matrix channel if I introduced an API change

@christianlupus
Copy link
Collaborator Author

This is a follow-up of #1544.

@christianlupus
Copy link
Collaborator Author

/approve

Copy link
Collaborator

@nextcloud-cookbook-bot nextcloud-cookbook-bot left a comment

Choose a reason for hiding this comment

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

Automatically approved by GitHub action on behalf of /approve

@codecov
Copy link

codecov bot commented May 28, 2023

Codecov Report

Merging #1700 (219e3a9) into master (91c7708) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1700   +/-   ##
=======================================
  Coverage   79.41%   79.41%           
=======================================
  Files          87       87           
  Lines        2550     2550           
=======================================
  Hits         2025     2025           
  Misses        525      525           
Flag Coverage Δ
integration 21.21% <ø> (ø)
migration 5.92% <ø> (ø)
unittests 56.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@github-actions
Copy link

Test Results

     27 files  1 233 suites   7m 23s ⏱️
   498 tests    498 ✔️ 0 💤 0
4 482 runs  4 481 ✔️ 1 💤 0

Results for commit fa732d3.

This reverts commit 07954bf.

The @type annotation should be still part of the OpenAPI description. Although the returned
JSON objects are considered compatible with the schema.org standard, this does not mean, we
should not make the implications explicit. Also, this makes reading more clean and avoid
misunderstandings regarding if the @type is to be present or not.

Signed-off-by: Christian Wolf <github@christianwolf.email>
Signed-off-by: Christian Wolf <github@christianwolf.email>
@christianlupus christianlupus merged commit fc9a28e into master May 28, 2023
37 checks passed
@christianlupus christianlupus deleted the revert/openapi-without-type branch May 28, 2023 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants