SAP/abapGit
1
0
Fork 0
mirror of https://github.com/abapGit/abapGit.git synced 2025-04-30 20:03:20 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: API documentation updates (#4535)

Browse Source 
* docs: API documentation updates

* remove broken link

* add note regarding branch creation

* fix typo

* Update api.md
This commit is contained in:
Lars Hvam 2021-02-20 13:08:28 +01:00 committed by GitHub
parent 40cd29297d
commit 38854d54d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/collections/_development/api.md
View File

@ -85,7 +85,7 @@ Delete all objects that are part of an abapGit repository (i.e. full uninstall):
```abap
ls_checks = lo_repo->delete_checks( ).
IF ls_checks-transport-required = abap_true.
ls_checks-transport-transport = 'SIDK900000'. "transport ewquest
ls_checks-transport-transport = 'SIDK900000'. "transport request
ENDIF.
zcl_abapgit_repo_srv=>get_instance( )->purge(
@ -108,7 +108,7 @@ DATA(lt_result) = zcl_abapgit_file_status=>status( lo_repo ).
The following tasks are supported for online repositories only (`lo_repo type ref to zcl_abapgit_repo_online`).
**Note:** Certain tasks will require authentication (user/password or token). In such cases, you will have to provide the login details upfront (see [#1331](https://github.com/abapGit/abapGit/issues/1331) for details):
**Note:** Certain tasks will require authentication (user/password or token). In such cases, you will have to provide the login details upfront (see [#1331](https://github.com/abapGit/abapGit/issues/1331) for details), authentication can also be set via user exit or configured in SM59,
```abap
zcl_abapgit_login_manager=>set(
@ -122,7 +122,8 @@ zcl_abapgit_login_manager=>set(
Get a list of all branches (including main branch):
```abap
zcl_abapgit_git_transport=>branches( lo_repo->get_url( ) ).
lo_branches = zcl_abapgit_git_transport=>branches( lo_repo->get_url( ) ).
lt_list = lo_branches->get_branches_only( ).
```
### Switch Branch ###
@ -135,7 +136,7 @@ lo_repo->set_branch_name( lv_name ).
### Create Branch ###
Create a new branch in an online repository:
Create a new branch in an online repository, note that IV_FROM can also be set, if not the branch will be created from the current checked out SHA1 of the repo,
```abap
lo_repo->create_branch( lv_name ).

2
docs/guide-regular-backup.md
View File

@ -16,7 +16,7 @@ Steps:
4. Clone the repository using abapGit, into the package that should be backed up. abapGit will not delete any objects in the package
5. [Enable write protection](ref-write-protect.html)
5. Enable write protection
6. Test backup by staging + commit + pushing from abapGit manually