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

Core API docu #602

Merged
merged 24 commits into from
Jul 3, 2019
Merged

Core API docu #602

merged 24 commits into from
Jul 3, 2019
+347 −37

Conversation

maxmarkus
Copy link
Contributor

@maxmarkus maxmarkus commented Jun 24, 2019 •
edited
Loading

Docu for Core APIs:

  • Luigi (config)
  • Luigi.elements()
  • Luigi.auth()

@maxmarkus maxmarkus added this to the Sprint_1 milestone Jun 24, 2019
@maxmarkus maxmarkus added the documentation documentation tasks label Jun 24, 2019
@pekura pekura self-assigned this Jun 24, 2019
pekura
pekura suggested changes Jun 24, 2019
View reviewed changes
docs/luigi-core-api.md Outdated

##### Parameters

- `configInput` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** the Luigi Core configuration object
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the question mark at the end (by removing the square brackets around the parameter name in the source file).

docs/luigi-core-api.md Outdated

##### Parameters

- `property` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** the object traversal path
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the question mark at the end (by removing the square brackets around the parameter name in the source file).

docs/luigi-core-api.md Outdated

##### Parameters

- `property` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** the object traversal path
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the question mark at the end (by removing the square brackets around the parameter name in the source file).

docs/luigi-core-api.md Outdated

##### Parameters

- `property` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** the object traversal path
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the question mark at the end (by removing the square brackets around the parameter name in the source file).

docs/luigi-core-api.md Outdated
##### Parameters

- `property` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** the object traversal path
- `parameters` **mixed?** optional parameters that are used if the target is a function
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the question mark at the end (by removing the square brackets around the parameter name in the source file).

docs/luigi-core-api.md Outdated
##### Examples

```javascript
Luigi.config().getConfigValue('auth.use')
Copy link
Contributor

Choose a reason for hiding this comment

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

Luigi.config() is not made available globally; this call leads to "TypeError: Luigi.config is not a function". The config related functions are available on root level of Luigi object.

@maxmarkus maxmarkus requested a review from pekura June 26, 2019 07:14
@maxmarkus maxmarkus removed this from the Sprint_1 milestone Jul 1, 2019
bszwarc
bszwarc suggested changes Jul 3, 2019
View reviewed changes
Copy link
Contributor

@bszwarc bszwarc left a comment

Choose a reason for hiding this comment

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

Added comments

docs/README.md Outdated Show resolved Hide resolved
client/src/linkManager.js Outdated Show resolved Hide resolved
client/src/uxManager.js Outdated Show resolved Hide resolved
docs/luigi-client-api.md Outdated Show resolved Hide resolved
client/src/uxManager.js Outdated Show resolved Hide resolved
@maxmarkus maxmarkus requested a review from bszwarc July 3, 2019 08:24
@maxmarkus maxmarkus merged commit c11e850 into SAP:master Jul 3, 2019
@maxmarkus maxmarkus deleted the 567-core-api-docu branch July 3, 2019 09:29
stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
@maxmarkus
Core API docu (SAP#602)
10439f8 
documented core api
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pekura pekura pekura approved these changes

@JohannesDoberer JohannesDoberer JohannesDoberer approved these changes

@bszwarc bszwarc bszwarc approved these changes

@hardl hardl Awaiting requested review from hardl hardl is a code owner

@jesusreal jesusreal Awaiting requested review from jesusreal

@kazydek kazydek Awaiting requested review from kazydek

@marynaKhromova marynaKhromova Awaiting requested review from marynaKhromova

@mmitoraj mmitoraj Awaiting requested review from mmitoraj

@tomekpapiernik tomekpapiernik Awaiting requested review from tomekpapiernik

Assignees

@pekura pekura

@JohannesDoberer JohannesDoberer

Labels
documentation documentation tasks
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@maxmarkus @pekura @JohannesDoberer @bszwarc @jesusreal