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.

Sign up for GitHub

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

Jump to bottom

(BSR) docs: Add deprecation warning for beginningDatetime field in co… #15850

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

(BSR) docs: Add deprecation warning for beginningDatetime field in co… #15850

wants to merge 1 commit into from
+21 −5

Conversation

jcicurel-pass
Copy link
Contributor

…llective public api

But de la pull request

Ticket Jira (ou description si BSR) : https://passculture.atlassian.net/browse/PC-33977

Vérifications

  • J'ai écrit les tests nécessaires
  • J'ai mis à jour le fichier des plans de tests du portail pro si nécessaire
  • J'ai mis à jour la liste des routes et des titres de pages du portail pro si j'en ai rajouté/modifié ou supprimé une.
  • J'ai relu attentivement les migrations, en particulier pour éviter les locks, et je préviens les équipes Shérif et Data
  • J'ai ajouté des screenshots pour d'éventuels changements graphiques
  • J'ai fait la revue fonctionnelle de mon ticket

@jcicurel-pass jcicurel-pass marked this pull request as ready for review January 14, 2025 10:56
@github-actions GitHub Actions
Copy link
Contributor

Visit the preview URL for this PR (updated for commit b214143):

https://pc-pro-testing--pr15850-public-api-beginning-oxskva96.web.app

(expires Thu, 16 Jan 2025 10:57:45 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 032d233ee67e1c50d6af12e29c936c7076770eb1

ahello-pass
ahello-pass approved these changes Jan 14, 2025
View reviewed changes
api/documentation/src/pages/change-logs.md
Comment on lines +20 to +21
- [**Get Collective Offer endpoint**](/rest-api#tag/Collective-Offers/operation/GetCollectiveOfferPublic)
- [**Get Collective Offers endpoint**](/rest-api#tag/Collective-Offers/operation/GetCollectiveOffersPublic)
Copy link
Contributor

Choose a reason for hiding this comment

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

Il y a deux fois l'endoint Get Collective Offer endpoint, c'est normal ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Il y a Offer (récupérer une offre) et Offers (toutes les offres)

Copy link
Contributor

Choose a reason for hiding this comment

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

Merci ! Sorry j'ai lu trop vite

api/documentation/src/pages/change-logs.md

Please use the `startDatetime` and `endDatetime` fields instead.

The `startDatetime` field will be required when creating a collective offer and its value will be copied to `endDatetime` if `endDatetime` is not provided.
Copy link
Contributor

Choose a reason for hiding this comment

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

Super ! Est-ce qu'on ne mentionnerait pas ça aussi directement dans la description du champ dans la doc openapi ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Je pense pas qu'il faille mettre ça dans la doc actuelle du champ, on pourrait s'emmêler et penser que cette logique s'applique dès maintenant non ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, donc on se note de l'ajouter dans la PR qui supprime beginningDatetime de l'API ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes je l'ai mis dans l'autre PR -> #15840

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ahello-pass ahello-pass ahello-pass approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jcicurel-pass @ahello-pass