[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-12 Thread Addshore
Addshore added a comment.


  In T264555#6529839 , 
@Lydia_Pintscher wrote:
  
  > Even if we add those plus say 3 or 4 entity types that might come in the 
next years (can't even think of that many concrete ones atm) it still seems 
like a manageable number to me fwiw.
  
  Indeed.
  The argument for splitting these by entity type is challenged in T264086 
 which could see is simply returning 
to /entities/
  
  We will wait and make decisions here and on that ticket after the further 
feedback round.

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Addshore
Cc: Lydia_Pintscher, Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, 
Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, 
LawExplorer, _jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-08 Thread Lydia_Pintscher
Lydia_Pintscher added a comment.


  In T264555#6528542 , 
@Addshore wrote:
  
  > In T264555#6522679 , 
@Lydia_Pintscher wrote:
  >
  >> In T264555#6521316 , 
@Addshore wrote:
  >>
  >>> One of the reasons here was due to not wanting the ever growing list of 
entity types to slowly "pollute" the route level of the api.
  >>
  >> Do we expect that many new entity types to come in the foreseeable future? 
It seems to me the current number of entity types is manageable and is unlikely 
to grow significantly.
  >
  > One thing that this likely depends on is how we end up handling the other 
entity types that we already have in the REST API, eg Lexeme and Mediainfo.
  > Will they be represented here at all? or in their own APIs?
  
  Even if we add those plus say 3 or 4 entity types that might come in the next 
years (can't even think of that many concrete ones atm) it still seems like a 
manageable number to me fwiw.

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Lydia_Pintscher
Cc: Lydia_Pintscher, Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, 
Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, 
LawExplorer, _jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-08 Thread Addshore
Addshore added a comment.


  > Also, why should /statements get to have a shortcut but /items and 
/properties don't?
  
  For the decision to have a statements endpoint at the top level I'd defer to 
the decision doc which currently says:
  
  --
  
  Entities + Statements
  -
  
  **Decision: Statements would be exposed both within an entity and also at the 
top level**
  
  Considered options:
  
  - For the statements with a GUID:
- Should we address those always through entities?
  - longer path
  - the entity id is already in the path and the prefix is redundant
  - Or individually, through a /statements path?
  
  Usefulness (end users) Vs. cost of ownership (devs)
  
  Notes
  -
  
  The current Action API allows you to get a statement with only the GUID 
(without the entity id prefix) with no extra work
  
  Not having a top level statement endpoint would mean that “extra work” would 
be needed by the client in order to access a statement (splitting the statement 
ID)
  
  Taking this into account we can cover all of our existing APIs with REST APIs 
only if we do have statements as a top level api module.

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Addshore
Cc: Lydia_Pintscher, Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, 
Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, 
LawExplorer, _jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-08 Thread Addshore
Addshore added a comment.


  > TBA ticket for documenting this more
  
  That ticket is T264747: Document the decision on choosing /entity/item/Q123 
over /entity/Q123 

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Addshore
Cc: Lydia_Pintscher, Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, 
Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, 
LawExplorer, _jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-08 Thread Addshore
Addshore added a comment.


  In T264555#6522679 , 
@Lydia_Pintscher wrote:
  
  > In T264555#6521316 , 
@Addshore wrote:
  >
  >> One of the reasons here was due to not wanting the ever growing list of 
entity types to slowly "pollute" the route level of the api.
  >
  > Do we expect that many new entity types to come in the foreseeable future? 
It seems to me the current number of entity types is manageable and is unlikely 
to grow significantly.
  
  One thing that this likely depends on is how we end up handling the other 
entity types that we already have in the REST API, eg Lexeme and Mediainfo.
  Will they be represented here at all? or in their own APIs?

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Addshore
Cc: Lydia_Pintscher, Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, 
Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, 
LawExplorer, _jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-06 Thread Lydia_Pintscher
Lydia_Pintscher added a comment.


  In T264555#6521316 , 
@Addshore wrote:
  
  > One of the reasons here was due to not wanting the ever growing list of 
entity types to slowly "pollute" the route level of the api.
  
  Do we expect that many new entity types to come in the foreseeable future? It 
seems to me the current number of entity types is manageable and is unlikely to 
grow significantly.

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Lydia_Pintscher
Cc: Lydia_Pintscher, Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, 
Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, 
LawExplorer, _jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-06 Thread Addshore
Addshore added a comment.


  I vaugly remember that we consciously made the decision to include 
`/entities/` in the path but we should go back and find what we decided and 
document it.
  
  One of the reasons here was due to not wanting the ever growing list of 
entity types to slowly "pollute" the route level of the api.
  We also discussed how things such as MediaInfo or Lexeme might impact this 
decision, although right now we are aiming to plan that far ahead.
  
  Some things have changed since the original decision (things now look 
differently in the swagger spec) that might lead us to thinking something else 
is appropriate.
  
  TBA ticket for documenting this more

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Addshore
Cc: Addshore, Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, Akuckartz, 
darthmon_wmde, Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, LawExplorer, 
_jensen, rosalieper, Scott_WUaS, Wikidata-bugs, aude, Lydia_Pintscher, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-06 Thread Pablo-WMDE
Pablo-WMDE added a comment.


  possible arguments:
  
  - extensibility (all entity types added in one "bucket" and not the root)
  - cost of ownership of the "shortcuts" is probably small but > 0

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Pablo-WMDE
Cc: Pablo-WMDE, WMDE-leszek, Silvan_WMDE, Aklapper, Akuckartz, darthmon_wmde, 
Nandana, Lahi, Gq86, GoranSMilovanovic, QZanden, LawExplorer, _jensen, 
rosalieper, Scott_WUaS, Wikidata-bugs, aude, Lydia_Pintscher, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-06 Thread WMDE-leszek
WMDE-leszek added a comment.


  possible related report: T264086  
(possibly different motivation though)

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: WMDE-leszek
Cc: WMDE-leszek, Silvan_WMDE, Aklapper, Akuckartz, darthmon_wmde, Nandana, 
Lahi, Gq86, Pablo-WMDE, GoranSMilovanovic, QZanden, LawExplorer, _jensen, 
rosalieper, Scott_WUaS, Wikidata-bugs, aude, Lydia_Pintscher, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs


[Wikidata-bugs] [Maniphest] T264555: Consider "shortcut" URL paths for /items and /properties

2020-10-04 Thread Silvan_WMDE
Silvan_WMDE created this task.
Silvan_WMDE added projects: Wikibase REST API Schema, Wikidata.
Restricted Application added a subscriber: Aklapper.

TASK DESCRIPTION
  The /entity/{entity_type}/{entity_id} URL schema seems quite intuitive for 
people who are familiar with Wikibase, because both items and properties are 
entities and their "item ids" and "property ids" are in fact also "entity ids".
  
  However, it is not immediately obvious why that relation must always be 
represented in the URL path. Also, why should `/statements` get to have a 
shortcut but `/items` and `/properties` don't?
  
  Proposed complete set of endpoints:
  
/entities/{entity_type}
/entities/{entity_type}/{entity_id}
/entities/{entity_type}/{entity_id}/sitelinks
/entities/{entity_type}/{entity_id}/sitelinks/{wiki_id}
/entities/{entity_type}/{entity_id}/labels
/entities/{entity_type}/{entity_id}/labels/{lang}
/entities/{entity_type}/{entity_id}/descriptions
/entities/{entity_type}/{entity_id}/descriptions/{lang}
/entities/{entity_type}/{entity_id}/aliases
/entities/{entity_type}/{entity_id}/aliases/{lang}
/entities/{entity_type}/{entity_id}/statements
/entities/{entity_type}/{entity_id}/statements/{statement_id}
/entities/{entity_type}/{entity_id}/statements/{statement_id}/qualifiers

/entities/{entity_type}/{entity_id}/statements/{statement_id}/qualifiers/{qualifier_hash}
/entities/{entity_type}/{entity_id}/statements/{statement_id}/references

/entities/{entity_type}/{entity_id}/statements/{statement_id}/references/{reference_hash}

/items
/items/{item_id}
/items/{item_id}/sitelinks
/items/{item_id}/sitelinks/{wiki_id}
/items/{item_id}/aliases
/items/{item_id}/aliases/{lang}
/items/{item_id}/descriptions
/items/{item_id}/descriptions/{lang}
/items/{item_id}/labels
/items/{item_id}/labels/{lang}
/items/{item_id}/statements
/items/{item_id}/statements/{statement_id}
/items/{item_id}/statements/{statement_id}/qualifiers
/items/{item_id}/statements/{statement_id}/qualifiers/{qualifier_hash}
/items/{item_id}/statements/{statement_id}/references
/items/{item_id}/statements/{statement_id}/references/{reference_hash}

/properties
/properties/{property_id}
/properties/{property_id}/labels
/properties/{property_id}/labels/{lang}
/properties/{property_id}/descriptions
/properties/{property_id}/descriptions/{lang}
/properties/{property_id}/aliases
/properties/{property_id}/aliases/{lang}
/properties/{property_id}/statements
/properties/{property_id}/statements/{statement_id}
/properties/{property_id}/statements/{statement_id}/qualifiers

/properties/{property_id}/statements/{statement_id}/qualifiers/{qualifier_hash}
/properties/{property_id}/statements/{statement_id}/references

/properties/{property_id}/statements/{statement_id}/references/{reference_hash}

/statements/{statement_id}
/statements/{statement_id}/qualifiers
/statements/{statement_id}/qualifiers/{qualifier_hash}
/statements/{statement_id}/references
/statements/{statement_id}/references/{reference_hash}

TASK DETAIL
  https://phabricator.wikimedia.org/T264555

WORKBOARD
  https://phabricator.wikimedia.org/project/board/5003/

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Silvan_WMDE
Cc: Silvan_WMDE, Aklapper, Akuckartz, darthmon_wmde, Nandana, Lahi, Gq86, 
Pablo-WMDE, GoranSMilovanovic, QZanden, LawExplorer, _jensen, rosalieper, 
Scott_WUaS, Wikidata-bugs, aude, Lydia_Pintscher, Mbch331
___
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs